/**
 * Copyright © 2016-2025 The Thingsboard Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.thingsboard.mqtt.broker.integration.api;

import org.thingsboard.mqtt.broker.common.data.exception.ThingsboardException;
import org.thingsboard.mqtt.broker.common.data.integration.Integration;
import org.thingsboard.mqtt.broker.common.data.integration.IntegrationLifecycleMsg;
import org.thingsboard.mqtt.broker.gen.integration.PublishIntegrationMsgProto;
import org.thingsboard.mqtt.broker.integration.api.callback.IntegrationMsgCallback;

import java.util.UUID;

public interface TbPlatformIntegration {

    IntegrationLifecycleMsg getLifecycleMsg();

    void validateConfiguration(IntegrationLifecycleMsg lifecycleMsg, boolean allowLocalNetworkHosts) throws ThingsboardException;

    void checkConnection(Integration integration, IntegrationContext ctx) throws ThingsboardException;

    void init(TbIntegrationInitParams params) throws Exception;

    void update(TbIntegrationInitParams params) throws Exception;

    void destroy();

    void destroyAndClearData();

    void process(PublishIntegrationMsgProto msg, IntegrationMsgCallback callback);

    IntegrationStatistics popStatistics();

    String getIntegrationId();

    UUID getIntegrationUuid();
}
